Appointment Business Tasks

Business tasks are tasks that are linked to code in N4 that allow for customized gate processing. You can configure business tasks to read or create new data for a gate transaction or truck visit, reject an appointment per the business rules required, and print gate documents for a gate transaction.

For more information on configuring business tasks, see Business Tasks (on page 1) form in the Navis N4: Gate Administrator and User Guide or in the online help.

You can include or exclude the following business tasks in N4 to configure the cargo appointments for the Deliver Break-Bulk (DB) and Receive Break-Bulk (RB) transaction types.

RejectCargoBLUnknownOrLineMismatch

Description

The business task rejects an appointment if the bill of lading (BL) number entered in the BL Number field does not match with the selected line operator or if the BL number is unknown.

Parameters

None

Dependencies

None

Timing

If the business task is included in the Include column, N4 processes it when you click Save in the Appointment form (on page 1).

Custom Code

Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.

RejectCargoMaxQtyQuotaExceeded

Description

This business task rejects an appointment if the cargo appointment quantity exceeds the cargo quantity set in the cargo quota rules for an appointment.

Parameters

None

Dependencies

You must define the cargo quota rules for the cargo appointment rule set (on page 1).

Timing

If the business task is included in the Include column, N4 processes it when you click Save in the Appointment form (on page 1).

Custom Code

Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.

RejectCargoMaxVolumeQuotaExceeded

Description

This business task rejects an appointment if the cargo volume in the appointment exceeds the cargo volume set in the cargo quota rules for an appointment.

Parameters

None

Dependencies

You must define the cargo quota rules for the cargo appointment rule set (on page 1).

Timing

If the business task is included in the Include column, N4 processes it when you click Save in the Appointment form (on page 1).

Custom Code

Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.

RejectCargoMaxWeightQuotaExceeded

Description

This business task rejects an appointment if the cargo gross weight in the appointment exceeds the cargo weight set in the cargo quota rules for an appointment.

Parameters

None

Dependencies

You must define the cargo quota rules for the cargo appointment rule set (on page 1).

Timing

If the business task is included in the Include column, N4 processes it when you click Save in the Appointment form (on page 1).

Custom Code

Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.

RejectCargoQtyExceedsBlItem

Description

This business task rejects an appointment if the cargo appointment quantity exceeds the bill of lading item quantity.

Parameters

None

Dependencies

None

Timing

If the business task is included in the Include column, N4 processes it when you click Save in the Appointment form (on page 1).

Custom Code

Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.

RejectCargoQtyExceedsDoItem

Description

The business task rejects an appointment if the cargo appointment quantity exceeds the Delivery Order item quantity.

Parameters

None

Dependencies

None

Timing

If the business task is included in the Include column, N4 processes it when you click Save in the Appointment form (on page 1).

Custom Code

Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.

RejectCargoVolumeExceedsBLItem

Description

The business task rejects an appointment if the cargo appointment volume exceeds the bill of lading item volume.

Parameters

None

Dependencies

None

Timing

If the business task is included in the Include column, N4 processes it when you click Save in the Appointment form (on page 1).

Custom Code

Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.

RejectCargoWeightExceedsBLItem

Description

This business task rejects an appointment if the cargo appointment gross weight exceeds the bill of lading item weight.

Parameters

None

Dependencies

None

Timing

If this business task is included in the Include column, N4 processes it when you click Save in the Appointment form (on page 1).

Custom Code

Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.

RejectInvalidBbkUnit

Description

This business task rejects the appointment if the unit ID entered in the Unit Id field in the Appointment form is:

• Not associated with the selected bill of lading (BL) item

• Is invalid

• Not in the yard

Parameters

None

Dependencies

None

Timing

If the business task is included in the Include column, N4 processes it when you click Save in the Appointment form (on page 1).

Custom Code

Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.

RejectDriverNotProvided

Rejects a gate transaction without a Driver License or Driver Card ID specified.

RejectAppointmentNotMatchingTVAppointmentDriver

Rejects the association of the transaction appointment with a truck visit appointment if the driver card ID does not match. If the driver card ID is not specified in either the transaction or truck visit appointment, this business task does not check for a driver mismatch.

The RejectAppointmentNotMatchingTVAppointmentDriver business task replaces the truck visit level RejectAppointmentForDifferentDriver business task.

To run this business task, you must select Actions Include Dispatch Business Task. This ensures that N4 executes this business task when a user associates a transaction appointment with a truck visit appointment.

RejectAppointmentNotMatchingTVAppointmentTrkCo

Rejects the association of the transaction appointment with a truck visit appointment if the trucking company does not match. If the trucking company is not specified in either the transaction or truck visit appointment, this business task does not check for a trucking company mismatch.

To run this business task, you must select Actions Include Dispatch Business Task. This ensures that N4 executes this business task when a user associates a transaction appointment with a truck visit appointment.

RejectAppointmentLineMismatch

Description

The business task rejects a gate transaction if the container line operator specified at the gate does not match the line operator specified in the appointment.

Parameters

None

Dependencies

None

Timing

• For gate transactions, such as Receive Export or Receive Empty, N4 processes tasks when you click the Save Transaction button on the gate transaction section of the <GateStage> tab (on page 1).

Custom Code

Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.

RejectAppointmentNotMatchingTVAppointmentTruck

Rejects the association of the transaction appointment with a truck visit appointment if the truck license number does not match. If the truck license number is not specified in either the transaction or truck visit appointment, this business task does not check for a truck mismatch.

To run this business task, you must select Actions Include Dispatch Business Task. This ensures that N4 executes this business task when a user associates a transaction appointment with a truck visit appointment.

RejectDriverSuspended

Rejects a gate transaction if the specified truck driver has been suspended from the facility. For more information, see Driver form (on page 1).

RejectDriverUnknown

Rejects a gate transaction if the specified truck driver record does not exist or is Obsolete.

You can also use this business task to reject a gate transaction when the CreateNewDriver (on page 1) business task is included but cannot create a new driver record using the information entered at the gate.

RejectTruckingCompanyBanned

Rejects a gate transaction if the specified trucking company is banned from the facility, or if the specified gate transaction type is not allowed for the trucking company. The RejectTruckingCompanyBanned business task is applicable at the gate transaction level and rejects a gate transaction if the trucking company is specified at the gate transaction level. If the trucking company is specified at the truck visit level, N4 generates an error for a banned trucking company irrespective of whether the RejectTruckingCompanyBanned business task is included in the gate configuration or not.

RejectTruckingCompanyUnknown

Rejects a transaction if the specified trucking company does not exist.

Exclude this business task at the appointment stage if you do not want to reject an appointment created using the COPINO EDI message if the trucking company does not exist.

Include this business task at the appointment stage if you want to reject an appointment created using the COPINO EDI message if the trucking company does not exist.

RejectUnitServiceRules

Description

The business task rejects a gate transaction if the following conditions are true:

• An active hold/permission exists for the unit (container or chassis) specified in the appointment or gate form

• An active hold/permission exists for a guardian, such as equipment, export booking, or bill of lading, of the unit specified in the gate form.

• The hold/permission is associated with a service business rule that prevents the gate transaction from occurring.

For example, if you include the RejectUnitServiceRules business task at the appointment stage, N4 returns an error if the unit specified in the appointment has a ‘Hold On Guardian’.

If a permission is required for the bill of lading specified in the gate form, and the permission is associated with a service business rule that prevents a UNIT_DELIVER event for the unit (guarded entity) requested at the gate, N4 rejects the deliver gate transaction.

If you include the RejectUnitServiceRules business task in your gate configuration, the business task covers the following scenarios for a gate transaction including a chassis:

• If you are delivering a chassis that has a hold, the business task returns an error.

• If you are delivering a container on a chassis that has a hold, the business task returns an error.

• If you are delivering a container on a chassis and both the container and the chassis have a hold, the business task returns two separate errors, one for the container hold and the other for the chassis hold.

• If you are delivering a container on a chassis, and only the container has a hold, the container and the chassis gates out without any errors.

The business task does not return any errors if the gate transaction is using an Owner chassis.

For Break-Bulk Cargo

For the Break-Bulk gate transaction types, N4 checks the Bill of Lading specified at the gate and not the Cargo Lot. N4 rejects a gate transaction only if the Bill of Lading has a hold for the UNIT_DELIVER event and the RejectUnitServiceRules business task is included for the Deliver Break-Bulk (DB) gate transaction type.

We recommend that you include the RejectUnitServiceRules business task in at least one gate stage for each gate transaction type.

Parameters

IncludeCovertHold: Determines whether covert holds are evaluated at the ingate and outgate. By default, this is set to True for both the ingate and the outgate. It is recommended that you set this to False for each gate transaction type at the ingate stage. This enables the truck driver to come into the terminal unawares but prevents them from leaving due to the active covert hold. See also How do I create covert holds?

Event Type Override: Determines if N4 evaluates the RejectUnitServiceRules business task against the default event types or a specific event type. The default event types are UNIT_DELIVER for delivery gate transactions and UNIT_RECEIVE for receival gate transactions. When this parameter is not set or null, N4 uses the default event types. To define a specific event type, select the event type from the drop-down list.

The RejectUnitServiceRules business task does not support custom events. If the task is NOT parameterized with an event, N4 considers the UNIT_RECEIVE for receival transactions and UNIT_DELIVER and UNIT_OUT_GATE events for delivery transactions. To include custom events, you can add a groovy code for this business task.

Dependencies

None

Timing

• For appointments, N4 processes business tasks on two occasions:

• If the business task is included in the Include column, N4 processes it when you click Save in the Appointment form (on page 1).

• If the business task is included in the Include Dispatch column, N4 processes it when you click Save after associating the appointment with a truck visit appointment.

• For gate transactions, such as Receive Export or Receive Empty, N4 processes tasks when you click the Save Transaction button on the gate transaction section of the <GateStage> tab (on page 1).

Custom Code

Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.